Add docs #36
Add docs #36
Conversation
gadomski
force-pushed
the
issues/31-docs
branch
from
096d9d0
to
12ec99d
Compare
gadomski
force-pushed
the
issues/31-docs
branch
from
427b8cb
to
97c638d
Compare
gadomski
force-pushed
the
issues/31-docs
branch
from
97c638d
to
96f0118
Compare
I don't feel the need to have rust documentation in the mkdocs site. IMO any docs targeting rust users should live at
Yeah developmentseed.org is hosted on github pages I believe, so any repo's github pages automatically get served from developmentseed.org. |
| - name: Deploy | ||
| run: | | ||
| VERSION=$(git describe --tags --match="v*" --abbrev=0) | ||
| uv run mike deploy $VERSION latest --update-aliases --push |
There was a problem hiding this comment.
It's a personal nit to always have an end of line character on the last line. I set this in my editor settings and also have pre-commit setups that enforce this on my own projects: https://github.com/developmentseed/lonboard/blob/4af9e2de490e99092fffafae817078e30da94bc2/.pre-commit-config.yaml#L16
| run: uv sync | ||
| - name: Deploy | ||
| run: | | ||
| VERSION=$(git describe --tags --match="v*" --abbrev=0) |
There was a problem hiding this comment.
Do you expect to ever publish beta versions? I find myself pushing alpha/beta versions decently often, but don't want to publish those to the public docs website: https://github.com/developmentseed/lonboard/blob/4af9e2de490e99092fffafae817078e30da94bc2/.github/workflows/deploy-mkdocs.yml#L59-L63
There was a problem hiding this comment.
I don't anticipate that very often for this repo — my hope is that we bake it and it just gets used.
What I am changing
How I did it
How you can test it
Related Issues
--workspacein CI #35 as a drive-by, except forcargo fmtwhich doesn't support--workspace